Interface FlowMonitor

All Superinterfaces:
IPCObject
All Known Implementing Classes:
FlowMonitorImpl

public interface FlowMonitor extends IPCObject
Information provided by the PKI file:

    \class FlowMonitor
    
    \brief FlowMonitor holds and manipulates the flow monitor.
    
    \example network().getDevice("Router0").getNetflowMonitorManager().getMonitorAt(0)
    
Author:
Auto-generated
  • Method Details

    • getMonitorName

      String getMonitorName()
      Information provided by the PKI file:
      
          \brief Returns the name of the flow monitor.
          
          \return string, the name of the flow monitor.
          
              
      Returns:
      String Returns a String
    • getRecord

      FlowRecord getRecord()
      Information provided by the PKI file:
      
          \brief Returns the flow record.
          
          \return FlowRecord, the FlowRecord object.
          
              
      Returns:
      FlowRecord Returns a FlowRecord
    • unsetRecord

      void unsetRecord()
      Information provided by the PKI file:
      
          \brief Unsets the flow record.
          
              
    • getInterfaceInput

      FlowMonitorData getInterfaceInput(String interfaceName, boolean isIpv6)
      Information provided by the PKI file:
      
          \brief Returns the input flow monitor data on the specified interface.
          
          \param interfaceName,       interfaceName can be one of the following plus an interface number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param isIpv6, true if IPv6, false if IPv4.
          
          \return FlowMonitorData, the FlowMonitorData object.
          
              
      Parameters:
      interfaceName - Takes in a parameter of interfaceName
      isIpv6 - Takes in a parameter of isIpv6
      Returns:
      FlowMonitorData Returns a FlowMonitorData
    • getInterfaceOutput

      FlowMonitorData getInterfaceOutput(String interfaceName, boolean isIpv6)
      Information provided by the PKI file:
      
          \brief Returns the output flow monitor data on the specified interface.
          
          \param interfaceName,       interfaceName can be one of the following plus an interface number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param isIpv6, true if IPv6, false if IPv4.
          
          \return FlowMonitorData, the FlowMonitorData object.
          
              
      Parameters:
      interfaceName - Takes in a parameter of interfaceName
      isIpv6 - Takes in a parameter of isIpv6
      Returns:
      FlowMonitorData Returns a FlowMonitorData
    • getActiveFlowCount

      int getActiveFlowCount()
      Information provided by the PKI file:
      
          \brief Returns the number of active flows.
          
          \return int, the number of active flows.
          
              
      Returns:
      int Returns a int
    • getTotalFlowAdded

      int getTotalFlowAdded()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows.
          
          \return int, the total number of flows.
          
              
      Returns:
      int Returns a int
    • getMonitorDataCount

      int getMonitorDataCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flow monitor data.
          
          \return int, the number of flow monitor data.
          
              
      Returns:
      int Returns a int
    • getMonitorDataAt

      FlowMonitorData getMonitorDataAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the flow monitor data at the specified index.
          
          \param index, the index of the flow monitor data of interest.
          
          \return FlowMonitorData, the FlowMonitorData object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      FlowMonitorData Returns a FlowMonitorData
    • getExporterCount

      int getExporterCount()
      Information provided by the PKI file:
      
          \brief Returns the number of NetFlow exporters.
          
          \return int, the number of NetFlow exporters.
          
              
      Returns:
      int Returns a int
    • getExporterAt

      NFExporter getExporterAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow exporter at the specified index.
          
          \param index, the index of the NetFlow exporter of interest.
          
          \return NFExporter, the NFExporter object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NFExporter Returns a NFExporter
    • toString

      String toString()
      Information provided by the PKI file:
      
          \brief Returns the flow record output.
          
          \return string, the flow record output.
          
              
      Overrides:
      toString in class Object
      Returns:
      String Returns a String
    • monitorInUse

      boolean monitorInUse()
      Information provided by the PKI file:
      
          \brief Returns true if the flow monitor is in use, otherwise false.
          
          \return bool, true if the flow monitor is in use, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getCurrentEntryCount

      int getCurrentEntryCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flows.
          
          \return int, the number of flows.
          
              
      Returns:
      int Returns a int
    • getHighWaterMark

      int getHighWaterMark()
      Information provided by the PKI file:
      
          \brief Returns the high watermark value.
          
          \return int, the high watermark value.
          
              
      Returns:
      int Returns a int
    • getFlowsAddedCount

      int getFlowsAddedCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows.
          
          \return int, the total number of flows.
          
              
      Returns:
      int Returns a int
    • getFlowsAgedCount

      int getFlowsAgedCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of expired flows.
          
          \return int, the total number of expired flows.
          
              
      Returns:
      int Returns a int
    • getActiveTimeoutCount

      int getActiveTimeoutCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were closed due to long activity.
          
          \return int, the total number of flows that were closed due to long activity.
          
              
      Returns:
      int Returns a int
    • getInactiveTimeoutCount

      int getInactiveTimeoutCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were closed due to inactivity.
          
          \return int, the total number of flows that were closed due to inactivity.
          
              
      Returns:
      int Returns a int
    • getCacheDatabase

      CacheFlowDatabase getCacheDatabase()
      Information provided by the PKI file:
      
          \brief Returns cache flow database.
          
          \return CacheFlowDatabase, the CacheFlowDatabase object.
          
              
      Returns:
      CacheFlowDatabase Returns a CacheFlowDatabase